GET Notes?assetId={assetId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves notes for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetId |
Id of the asset |
globally unique identifier |
None. |
take |
Number of notes to retrieve. Default is all notes |
integer |
None. |
skip |
Number of notes to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the notes before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of notes.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of Note |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "NoteId": "3a3dedc2-c039-4811-8a96-627b774e1943", "Asset": { "AssetId": "beef4b46-01ed-407e-8cae-a082112b6847", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d5b8c992-7c02-4f4e-b863-b9a5ae90d0fb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8d5fe9c-45e3-4b26-bb84-bafc469aea88", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "49432eeb-f342-4b1d-b2de-ed72fbfd9644", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "MeasurementValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "SourceSystemId": "sample string 3", "CompanyId": "68e0468d-b5a4-452a-80f2-6e0bb5a113c4", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "6a22d4e7-4591-4a65-9a13-7f0d8f50f70a", "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "StateType": { "StateTypeId": "183658db-43c1-4e60-94bf-6e3caf2b3e11", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d5b8c992-7c02-4f4e-b863-b9a5ae90d0fb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8d5fe9c-45e3-4b26-bb84-bafc469aea88", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9aa9de64-a0f8-402b-8327-86b90e73d5bc", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "7f119096-c6df-415d-9230-550f06979395", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "546ed04c-1922-4caa-9a56-26511c0ad2bf", "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "StatusType": { "StatusTypeId": "55135711-0fbe-4e13-9f1c-d8582057a20b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d5b8c992-7c02-4f4e-b863-b9a5ae90d0fb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8d5fe9c-45e3-4b26-bb84-bafc469aea88", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "98404a0c-20d4-4a32-a092-8592fa65eeeb", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "172fad68-1362-4f47-b6ed-28832a2ea8be", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "772719aa-f112-4b13-ac58-588ba5bd9354", "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "WellPurposeType": { "WellPurposeTypeId": "196f4fae-65bb-40aa-83b8-f7183cc3bd56", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ec8173f2-b6b8-45fa-af70-b025d8fde870", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7d887b1b-d391-46e6-883c-fde22823c33b", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "MeasurementValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d4ba1ba2-a2e6-4a90-ac25-ee0a7ba3ce63", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "be0459c8-356e-4894-b7eb-3c2180f0627a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "a7293488-c918-4878-800e-7c098b9ec4db", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "57dda74d-e41c-4b79-a533-37b49f083ba3", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 5" }, { "NoteId": "3a3dedc2-c039-4811-8a96-627b774e1943", "Asset": { "AssetId": "beef4b46-01ed-407e-8cae-a082112b6847", "Name": "sample string 1", "Description": "sample string 2", "DisplayOrder": 1, "AssetType": { "AssetTypeId": "d5b8c992-7c02-4f4e-b863-b9a5ae90d0fb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8d5fe9c-45e3-4b26-bb84-bafc469aea88", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "AssetGroup": { "AssetGroupId": "49432eeb-f342-4b1d-b2de-ed72fbfd9644", "Name": "sample string 1", "Description": "sample string 2", "ParentGroup": null, "DisplayOrder": 1, "FormValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "MeasurementValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "SourceSystemId": "sample string 3", "CompanyId": "68e0468d-b5a4-452a-80f2-6e0bb5a113c4", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 6" }, "ParentAsset": null, "Location": "sample string 3", "Barcode": { "Format": 0, "Code": "sample string 1" }, "State": { "StateId": "6a22d4e7-4591-4a65-9a13-7f0d8f50f70a", "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "StateType": { "StateTypeId": "183658db-43c1-4e60-94bf-6e3caf2b3e11", "Name": "sample string 1", "IsOperational": true, "AssetType": { "AssetTypeId": "d5b8c992-7c02-4f4e-b863-b9a5ae90d0fb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8d5fe9c-45e3-4b26-bb84-bafc469aea88", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 3", "CompanyId": "9aa9de64-a0f8-402b-8327-86b90e73d5bc", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 6" }, "SourceSystemId": "sample string 1", "CompanyId": "7f119096-c6df-415d-9230-550f06979395", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 4" }, "Status": { "StatusId": "546ed04c-1922-4caa-9a56-26511c0ad2bf", "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "StatusType": { "StatusTypeId": "55135711-0fbe-4e13-9f1c-d8582057a20b", "Name": "sample string 1", "IsProducing": true, "IsInjecting": true, "AssetType": { "AssetTypeId": "d5b8c992-7c02-4f4e-b863-b9a5ae90d0fb", "Name": "sample string 1", "Description": "sample string 2", "IsWell": true, "DisplayColor": "sample string 4", "SourceSystemId": "sample string 5", "CompanyId": "c8d5fe9c-45e3-4b26-bb84-bafc469aea88", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "SourceSystemId": "sample string 4", "CompanyId": "98404a0c-20d4-4a32-a092-8592fa65eeeb", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "172fad68-1362-4f47-b6ed-28832a2ea8be", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 4" }, "WellPurpose": { "WellPurposeId": "772719aa-f112-4b13-ac58-588ba5bd9354", "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "WellPurposeType": { "WellPurposeTypeId": "196f4fae-65bb-40aa-83b8-f7183cc3bd56", "IsProducer": true, "IsInjector": true, "Name": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "ec8173f2-b6b8-45fa-af70-b025d8fde870", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 7" }, "SourceSystemId": "sample string 1", "CompanyId": "7d887b1b-d391-46e6-883c-fde22823c33b", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 3", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 4" }, "FormValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "MeasurementValueNeededDate": "2024-05-06T14:39:49.7494395-07:00", "HasChildren": true, "SourceSystemId": "sample string 5", "CompanyId": "d4ba1ba2-a2e6-4a90-ac25-ee0a7ba3ce63", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 7", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 8" }, "NoteCategory": { "NoteCategoryId": "be0459c8-356e-4894-b7eb-3c2180f0627a", "Name": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "a7293488-c918-4878-800e-7c098b9ec4db", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 5" }, "EffectiveDate": "2024-05-06T14:39:49.7494395-07:00", "NoteHTML": "sample string 1", "SourceSystemId": "sample string 2", "CompanyId": "57dda74d-e41c-4b79-a533-37b49f083ba3", "CreateDate": "2024-05-06T14:39:49.7494395-07:00", "CreateUser": "sample string 4", "LastModifiedDate": "2024-05-06T14:39:49.7494395-07:00", "LastModifiedUser": "sample string 5" } ], "Total": 1, "Message": "sample string 1" }